Fix docstring example: session.begin_transaction() needs to be awaited #807
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hello and thanks for taking the time to fix the docstring and opening this PR. Before I can even review it, I must ask you to sign our CLA (Contributor License Agreement). |
|
Sure! I just did it, sorry for the delay. It is a great module by the way: very clean and well documented! I just felt that a little detail like that fix can save someone some time. Thank you for taking the time to review it. |
|
Perfect. Thanks for the kind words and taking the time to contribute to our library! 🙌 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Found this error in the docstring while working with the async module of the driver. When the
sessionis an instance ofAsyncSessionthe method begin_transaction() is async and needs to be awaited. The example in the docstring was missing theawaitkeyword and running it as that returnsAttributeError: __aenter__